home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / opendoor.zip / OPENDOOR.DOC < prev    next >
Text File  |  1988-12-25  |  11KB  |  265 lines
  1.  
  2.                          O P E N D O O R
  3.  
  4.                     Release 1.0 in January 89
  5.                    Written by Fast Fingers ...
  6.                   The Sysop of the Tool Box BBS
  7.                     Sterling Heights, Michigan
  8.                       Phone # (313)-247-0094
  9.  
  10.  
  11.   SYSOP DOCUMENTATION for the OPENDOOR door utility BBS interface package.
  12.  
  13.  
  14.   *** INTRODUCTION ***
  15.  
  16.   I am frequently accused of supplying a two pound answer for a 3 ounce
  17.   question.  While the operation of this program is simple I have included
  18.   enough information here for you to really understand what's going on.  I
  19.   do this because many sysop's call my system somewhat confused by setting
  20.   up doors and the whole process is frustrating when a great game, "door",
  21.   can not be brought up on a system after quite an effort to get the program
  22.   in the first place was expended.
  23.  
  24.  
  25.   *** DELIVERABLES ***
  26.  
  27.   The package as you received it should have included the following files:
  28.  
  29.   OPENDR10.ARC
  30.     OpenDoor.Doc ... This file.
  31.     OpenDoor.Exe ... The compiled version of release 1.0.
  32.     OpenDoor.Def ... An example configuration file for this program.
  33.     OpenDoor.Bas ... The Quick Basic 4.0 source code.
  34.  
  35.  
  36.   *** GENERAL PURPOSE ***
  37.  
  38.   Many sysop's have trouble installing door programs written for bbs systems
  39.   different from what they are using.  On the other side of the issue are
  40.   the authors of door programs that really don't care about the variety of
  41.   bbs systems and simply want sysops to be able to use their programs easily.
  42.  
  43.   As I upgrade my various Ansi graphics/windowing doors I am removing all
  44.   bbs dependant logic from them.  However, they still do need to know some
  45.   basic information unique to each caller/bbs system, such as:
  46.  
  47.     The Users first name ...................... Joe
  48.     The Users last name ....................... Blow
  49.     The Current Communication parameters ...... COM1:2400,N,8,1
  50.     The Time left for BBS session ............. 32
  51.  
  52.  
  53.   *** OPERATION ***
  54.  
  55.   Fundamentally, OpenDoor.Exe is a program designed to reside in the same
  56.   directory as the BBS.  It merges the information needed, described above,
  57.   with information in the File "OPENDOOR.DEF" to create a file it puts in
  58.   the same directory as the door called "OPENDOOR.SYS".  It accomplishes
  59.   this task by having a bbs data dependant driver for each kind of BBS it
  60.   has been taught to understand.  As such, if your BBS type is not supported
  61.   by this program, and you are a little handy with QB4.0, you can add a new
  62.   subroutine that can extract the required information and all of the ansi
  63.   doors will now work with your type of BBS.
  64.  
  65.  
  66.   *** OPENDOOR.DEF ***
  67.  
  68.   The information merged with the user's unique parameters are stored in
  69.   the file called "OPENDOOR.DEF" and this file looks like this:
  70.  
  71. The Tool Box
  72. Fast
  73. Fingers
  74. COM1:
  75. PCBOARD.SYS
  76. 55
  77. OFF
  78.  
  79.   Line #1 The Name of the BBS ....................... The Tool Box
  80.   Line #2 The Sysop's first name .................... Fast
  81.   Line #3 The Sysop's last name ..................... Fingers
  82.   Line #4 The Default Com Port ...................... COM1:
  83.   Line #5 The Name of the BBS.SYS info file ......... PCBOARD.SYS
  84.   Line #6 The Maximum minutes allowed in door ....... 55
  85.   Line #7 The Debug Status of Door Operation ........ OFF
  86.  
  87.     Note: There can NOT be any ","'s in this file and the communications
  88.           port being used must be fully qualified as "COM1:" or "COM2:".
  89.       
  90.           This file must be located in the same directory as the BBS and
  91.           the "OPENDOOR.EXE" program.
  92.  
  93.  
  94.   *** OPENDOOR.SYS ***
  95.  
  96.   The merged result, "OPENDOOR.SYS" for the combined examples above would
  97.   look like the following:
  98.  
  99. The Tool Box
  100. Fast
  101. Fingers
  102. COM1:2400,N,8,1
  103. Joe
  104. Blow
  105. 32
  106. OFF
  107.  
  108.   This file will be created in the same directory as the door being run.
  109.  
  110.  
  111.   *** PCBOARD.SYS ***
  112.  
  113.   In the example above the "OPENDOOR.EXE" program assumed that a file
  114.   describing the user's situation existed in the BBS directory and it was
  115.   named "PCBOARD.SYS".  This file would look like the following:
  116.  
  117. -1 0 0 0  2400JOE BLOW                   JOE            -1PASSWORD----
  118. æ
  119. æ19:47
  120.  
  121.  Don't let this confuse you as interpretation is the purpose of this code.
  122.  Note however, that "OPENDOOR.EXE" will return, rather than call a door if
  123.  the user does NOT have ansi graphics enabled, NOT connected with no parity,
  124.  NOT using 8 data bits and 1 stop bit.
  125.  
  126.  
  127.  *** DATA FLOW SUMMARY ***
  128.  
  129.                                  ****************
  130.    *******    ***************    *              *
  131.    * BBS *===>* PCBOARD.SYS *===>*              *
  132.    *******    ***************    * OPENDOOR.EXE *    ****************
  133.       :                          *              *===>* OPENDOOR.SYS *
  134.       :      ****************    *              *    ****************
  135.       :      * OPENDOOR.DEF *===>*              *          :
  136.       :      ****************    *              *    ************    *********
  137.       :                          *              *===>* DOOR.EXE *===>* MODEM *
  138. ************    Arguments=>      *              *    ************    *********
  139. * DOOR.BAT *====================>*              *          :
  140. ************                     *              *    ************
  141.                                  ****************    * DOOR.DEF *
  142.                                                      ************
  143.  
  144.    USER => BBS => DOOR.BAT => OPENDOOR.EXE => DOOR.EXE => MODEM => USER
  145.  
  146.  
  147.   *** OPENDOOR.EXE (ARGUMENTS) ***
  148.  
  149.   The batch file that you set up to call "OPENDOOR.EXE" MUST supply the code
  150.   with at least one input parameter.  If you call it without any arguments
  151.   it assumes you are simply setting it up and it goes into instruction mode
  152.   operation giving you some help information on how to run it.
  153.  
  154.   The required argument, first one, is the fully qualified "Drive+Path+Door".
  155.   For example the statement could look like:
  156.  
  157. OPENDOOR.EXE D:\TAG\GAMES\CHECKERS\CHECKERS.EXE
  158.  
  159.   The second, optional, argument if supplied assumes you want to run the
  160.   door in local mode.  An example of this batch or dos command would be:
  161.  
  162. OPENDOOR.EXE D:\TAG\GAMES\CHECKERS\CHECKERS.EXE LOCAL
  163.  
  164.   Note: After a caller has accessed your door the only way to run it locally
  165.         again is either the above example or changing to the door directory,
  166.         deleting the opendoor.sys file and then keying in the name of the
  167.         door.
  168.  
  169.  
  170.   *** BBS SYSTEMS SUPPORTED ***
  171.  
  172.   As of this release the def file, Line #5, can be one of two settings.  One
  173.   is "PCBOARD.SYS" and the other is "DORINFO1.DEF".  The previous examples
  174.   all assumed the pcboard option.  RBBS and some of bulletin board systems
  175.   now support "DORINFO1.DEF".  While the information here is formatted its
  176.   own unique way the process is the same and the only change from your point
  177.   of view is the change to the one line in the opendoor.def file that
  178.   signals a different conversion is required.
  179.  
  180.  
  181.   *** ADDING ADDITIONAL BBS SUPPORT ***
  182.  
  183.   This same input, opendoor.def ... Line #5, is what you would change if
  184.   you decide to write a different bbs door driver subroutine.  In this case
  185.   don't worry about compiling the program with the DTR patches as this
  186.   program does not try to communicate over the modem.  If you do take this
  187.   path please study the driver for the pcboard.sys and follow the same type
  188.   procedures.  For example, the ansi doors do not support user names with
  189.   strange characters like "." included in them.  It strips these out.  So a
  190.   user with a bbs name "Superman .", where "." is the last name, will have
  191.   his/her named changed by opendoor to "Mr Superman".  This will allow the
  192.   doors to use the users name to determine the name of door data files
  193.   unique to the caller to save his game information.
  194.  
  195.   In general I am a strong supporter of self documenting programs.  You
  196.   will notice that I have left what most would consider an excessive
  197.   amount of REM statements in the code for the purpose of making any
  198.   enhancements at a later time easy.
  199.  
  200.  
  201.   *** OTHER DETAILS ***
  202.  
  203.   Some systems do not supply information you may wish, like the com port id.
  204.   Others do not supply the time left on the bbs.  These items are included
  205.   in the opendoor.def file so that the appropriate defaults may be used if
  206.   the info needed can not be obtained from the bbs.
  207.  
  208.   If you do write your own drivers, without changing the input/output to the
  209.   driver routines, please send them this way.  Over time I expect to upgrade
  210.   this utility to support a wide range of bulletin board systems.
  211.  
  212.   Make a batch file that calls OPENDOOR.EXE, mine looks something like
  213.   the following:
  214.     
  215.           ECHO TAG Batch file CHECKERS.BAT for checkers door
  216.           D:
  217.           CD \TAG
  218.           REM
  219.           REM Now call quickdor to convert TAG communications output
  220.           REM into a pcboard.sys format
  221.           REM
  222.           QUICKDOR %4,%5,%1,%6,%2,%3
  223.           REM
  224.           REM Now call opendoor configured for PCBOARD.SYS input
  225.           REM in its file named OPENDOOR.DEF
  226.           REM
  227.           D:\TAG\OPENDOOR.EXE D:\TAG\GAMES\CHECKERS\CHECKERS.EXE
  228.           REM
  229.           ECHO DOOR CLOSED
  230.           D:
  231.           CD \TAG
  232.  
  233.        Note: You notice that I didn't call watchdog as all of my doors
  234.              monitor the connection with the user themselves.  The QuickDor
  235.              line is unique to TAG.  If for example you were running a
  236.              RBBS system that outputs a DORINFO1.DEF file all you would need
  237.              is to setup the opendoor.def file correctly once and then have
  238.              a batch file with the single line:
  239.  
  240.                 OPENDOOR.EXE C:\RBBS\DOORS\CHECKERS.EXE
  241.  
  242.   Now do whatever it takes on your BBS to let it know you have another
  243.   great ansi-graphics door from Fast Fingers.
  244.  
  245.  
  246.   *** CLOSING CREDITS ***
  247.  
  248.   While I'm thinking of it, if you find this program useful take $50 of
  249.   your hard earned money and take your special somebody out on the town.
  250.   Tell them its on Fast Fingers!  There are no restrictions on anybody at
  251.   anytime or anyplace as to how they may use and/or modify this program.
  252.   I would however appreciate it if some reference to the original author
  253.   is left intact for my ego's reward for the effort expended to bring this
  254.   package into existence.  Thanks for taking the time to read all this
  255.   mostly unnecessary information.  I hope you enjoy it.  Have a good one!
  256.  
  257.  
  258.                             Enjoy!
  259.                             Fast Fingers ....
  260.  
  261.  
  262.   ps: Give my system a call some time and treat yourself to one of the
  263.       best BBS systems in the Midwest!
  264.  
  265.